PDF4Java Reference Documentation
com.o2sol.pdf4java.flowdocument Package / PDFFlowDocumentToCSettings Class
Methods


In This Topic
    PDFFlowDocumentToCSettings Class Members
    In This Topic

    The following tables list the members exposed by PDFFlowDocumentToCSettings.

    Public Constructors
     NameDescription
    Public ConstructorPDFFlowDocumentToCSettings ConstructorInitializes a new PDFFlowDocumentToCSettings object.  
    Top
    Public Methods
     NameDescription
    Public MethodgetContentsEntryFillerGets the contents entry filler.
    The character is multiplied as necessary to fill the space between the heading text and the page number.  
    Public MethodgetContentsEntrySpacingAfterGets the spacing after a table of contents entry.  
    Public MethodgetContentsEntrySpacingBeforeGets the spacing before a table of contents entry.  
    Public MethodgetContentsHeadingIndentGets the heading indent.  
    Public MethodgetContentsPageNumbersGets the collection of page numbers.
    The pairs in this collection specify a page and a number (or any string that can server as page number). If the page appears in the table of contents (because it contains a heading that is included in the table of contents), the corresponding page number will be displayed for the heading.  
    Public MethodgetContentsPagePositionGets the contents page position in the document.
    This value is used if method returns true.  
    Public MethodgetContentsTextColorGets the table of contents color.
    This value is used if method returns true.  
    Public MethodgetContentsTextFontGets the font for displaying the contents text.
    This value is used if method returns true.  
    Public MethodgetContentsTitleGets the table of contents title.
    Usually this property is a string like "Contents" or "Table of Contents".  
    Public MethodgetGenerateContentsPageGets a value indicating whether the table of contents should be generated as separate pages in the document.  
    Public MethodgetGenerateDocumentOutlineGets a value indicating whether the table of contents should be generated as document outline (bookmarks).  
    Public MethodgetMaxHeadingLevelForContentsPageGets the maximum heading level to be included in the contents page.
    This value is used if method returns true.  
    Public MethodgetMaxHeadingLevelForDocumentOutlineGets the maximum heading level to be included in the document outline.  
    Public MethodgetParentStructureElementForTableOfContentsGets the parent structure element for the table of contents.  
    Public MethodsetContentsEntryFillerSets the contents entry filler.
    The character is multiplied as necessary to fill the space between the heading text and the page number.
    This value is used if method returns true.  
    Public MethodsetContentsEntrySpacingAfterSets the spacing after a table of contents entry.
    This value is used if method returns true.  
    Public MethodsetContentsEntrySpacingBeforeSets the spacing before a table of contents entry.
    This value is used if method returns true.  
    Public MethodsetContentsHeadingIndentSets the heading indent.
    Level 1 headings are aligned to page's left margin. Level 2 headings are indented with space, level 3 headings are indented with 2 * space, and so on.
    This value is used if method returns true.  
    Public MethodsetContentsPageNumbersSets the collection of page numbers.
    The pairs in this collection specify a page and a number (or any string that can server as page number). If the page appears in the table of contents (because it contains a heading that is included in the table of contents), the corresponding page number will be displayed for the heading.  
    Public MethodsetContentsPagePositionSets the contents page position in the document.
    This value is used if method returns true.  
    Public MethodsetContentsTextColorSets the table of contents color.
    This value is used if method returns true.  
    Public MethodsetContentsTextFontSets the font for displaying the contents text.
    This value is used if method returns true.  
    Public MethodsetContentsTitleSets the table of contents title.
    Usually this property is a string like "Contents" or "Table of Contents".  
    Public MethodsetGenerateContentsPageSets a value indicating whether the table of contents should be generated as separate pages in the document.  
    Public MethodsetGenerateDocumentOutlineSets a value indicating whether the table of contents should be generated as document outline (bookmarks).  
    Public MethodsetMaxHeadingLevelForContentsPageSets the maximum heading level to be included in the contents page.
    This value is used if method returns true.  
    Public MethodsetMaxHeadingLevelForDocumentOutlineSets the maximum heading level to be included in the document outline.  
    Public MethodsetParentStructureElementForTableOfContentsSets the parent structure element for the table of contents.  
    Top
    See Also

    Reference

    PDFFlowDocumentToCSettings Class
    com.o2sol.pdf4java.flowdocument Package

     

     

    © 2025 O2 Solutions All Rights Reserved.

    Send comments on this topic.